Skip to content

fix: update exported member to use the proper package #358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 12, 2024
Merged

fix: update exported member to use the proper package #358

merged 1 commit into from
Sep 12, 2024

Conversation

@jasonmacdonald
Copy link
Contributor

@jasonmacdonald jasonmacdonald commented Sep 5, 2024 •
edited by coderabbitai bot
Loading

Fixes issue in #357

Summary by CodeRabbit

  • Documentation
    • Updated the Node.js plugin documentation to clarify the source of the DMMF type, enhancing user understanding of the Prisma integration within the Zenstack SDK.

@jasonmacdonald
Update 3-writing-plugins.md
0dd00cb 
Fixed an issue where the exported member did not exist
@vercel
Copy link

vercel bot commented Sep 5, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
zenstack-new-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 3:38pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 5, 2024 •
edited
Loading

Walkthrough

The changes involve modifying the import statements in the documentation for a Node.js plugin. The import of DMMF from the @zenstackhq/sdk package has been removed and replaced with an import from @zenstackhq/sdk/prisma, clarifying the source of the DMMF type. This adjustment ensures that users have a more precise reference regarding the DMMF type's origin while maintaining the existing functionality of the plugin.

Changes

File Path Change Summary
docs/the-complete-guide/part2/3-writing-plugins.md Removed import of DMMF from @zenstackhq/sdk and added import from @zenstackhq/sdk/prisma.

Possibly related issues

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b37c4f7 and 0dd00cb.

Files selected for processing (1)
  • docs/the-complete-guide/part2/3-writing-plugins.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/the-complete-guide/part2/3-writing-plugins.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ymc9
Copy link
Member

ymc9 commented Sep 12, 2024

Thank you for the fix @jasonmacdonald !

@ymc9 ymc9 merged commit 97c38fc into zenstackhq:main Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jasonmacdonald @ymc9